FlexiCapture offers intelligent document recognition and accurate data extraction from a full range of document types such as application forms, claim and order documents, invoices, or contracts.
Using "reading robots" involves three types of robot actions:
A robot or group of robots sends documents to the FlexiCapture Server.
A robot or group of robots monitors the different states of the batches documents being processed.
A robot or group of robots monitors the batches of documents being processed on the FlexiCapture Server.
Each of these functions would typically be completed by a different robot, or group of robots, however they could be perfromed by the same robot (this may be relevant for smaller deployments).
For more about this functionality and a working sample, see Using Advanced Document Processing (FlexiCapture).
To add Advanced Document Processing library objects to your project:
| 1. | Select Project > References > Library References. |
| 2. | Click New Reference. |
| 3. | Navigate to C:\Program Files (x86)\NICE Systems\Real-Time Designer. |
| 4. | Select Direct.FlexiCapture and click Open. |
The functions in this section are exposed under Business Entities > Library Types > Advanced Document Processing.
|
Function / Event |
Return Value |
Description |
Syntax |
|
FlexiCapture Batch Context Functions Used to add context to the document sent for processing. The context can then help determine how to handle the document data after it is processed. |
|||
|
Add Property |
None |
Adds the name and value of property to batch context. |
Add Property of FlexiCapture Batch Context <Select Name>, <Select Value> The properties are stored as Name/Value pairs.
|
|
Get Property Value |
Text |
Gets the value of the specified batch property. |
Get Property Value of FlexiCapture Batch Context <Select Property Name> |
|
FlexiCapture Batch Monitor Functions Used for monitoring states of documents sent for processing. |
|||
| Start | Boolean | Starts monitoring the processing stages on the FlexiCapture Server. |
Start of FlexiBatch Monitor <Select Address>, <Select Username>, <Select Password>, <Select Use HTTPS> |
| Stop | Boolean | Stops monitoring the processing stages on the FlexiCapture Server. | Stop of FlexiBatch Monitor |
|
FlexiCapture Batch Monitor Events |
|||
| Batch Failed | Triggered if the batch fails. | ||
| Batch Processed | Triggered if the batch is processed. | ||
| Batch Should be Verified | Triggered if the batch should be verified by an employee. | ||
| Connection Lost | Triggered if connection to the FlexiCapture Server is lost. | ||
| Connection Restored | Triggered if the connection to the FlexiCapture Server is restored. | ||
|
FlexiCapture Batch Monitor Business Entity |
|||
| Projects to Monitor | List of Text |
Used for defining which projects to monitor. You can have only one monitor per project. If you want multiple robots to monitor the documents, you need to specify a set of projects to monitor for each robot. If this list is empty, all projects are monitored by a single robot. |
|
|
FlexiCapture Service Functions Used to send documents for processing. |
|||
| Connect | Boolean | Connects to the FlexiCapture Server. | Connect of FlexiCapture Service <Select Address> , <Select Username> , <Select Password> , <Select Use HTTPS> |
|
Process Document |
Number |
Sends document to FlexiCapture Sever for processing. This returns the Batch Id - the ID of the batch. |
Process Document of FlexiCapture Service <Select Project Name> , <Select Batch Type> , <Select Document Path> , <Select Context> |
|
Download Batch Results |
FlexiCapture Process Document Result |
Retrieves the results of processed document from FlexiCapture Server. |
Download Batch Results of FlexiCapture Service <Select Project Id> , <Select Batch Id> , <Select Context> The results are returned in a FlexiCapture Process Document Result Business Entity with the following properties: Batch ID: The batch number. Context: The FlexiCapture Batch Context. Documents: A list of XML documents. Each XML reflects data which has been extracted from a document. Project ID: The project number. Status: The processing status (text). |
|
Disconnect |
Boolean |
Disconnects from the FlexiCapture Server. |
Disconnect of FlexiCapture Service |
|
Get Project Names |
List of Text |
Gets a list of available project names from the FlexiCapture Server. |
Get Project Names of FlexiCapture Service |
|
Get Batch Type Names |
List of Text |
Gets a list of batch type names from the FlexiCapture Server for the specified project. |
Get Batch Type Names of FlexiCapture Service |
